package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.NecessaryVariableAddDTO;
import org.jsola.hr.dto.NecessaryVariableBatchDTO;
import org.jsola.hr.dto.NecessaryVariableUpdateDTO;
import org.jsola.hr.query.NecessaryVariableQuery;
import org.jsola.hr.vo.NecessaryVariableListVO;
import org.jsola.hr.vo.NecessaryVariableVO;

import java.util.List;

/**
 * 员工必填信息关联变量
 *
 * @author zhr
 */
@Api(tags = "hr-员工必填信息关联变量")
public interface INecessaryVariableControllerAPI {

    /**
     * 新增员工必填信息关联变量
     * @param necessaryVariableAddDTO 员工必填信息关联变量新增实体
     * @return 员工必填信息关联变量展示对象
     */
    @ApiOperation(value = "新增员工必填信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "necessaryVariableAddDTO", dataType = "NecessaryVariableAddDTO", value = "新增员工必填信息关联变量", paramType = "body")
    })
    Result<NecessaryVariableVO> save(NecessaryVariableAddDTO necessaryVariableAddDTO);


    /**
     * 修改员工必填信息关联变量
     * @param necessaryVariableUpdateDTO 员工必填信息关联变量
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工必填信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "necessaryVariableUpdateDTO", dataType = "NecessaryVariableUpdateDTO", value = "修改员工必填信息关联变量", paramType = "body")
    })
    Result<Integer> update(NecessaryVariableUpdateDTO necessaryVariableUpdateDTO);

    /**
     * 批量编辑、新增、删除员工必填信息关联变量
     * @param necessaryVariableBatchDTO 要操作的员工必填信息关联变量
     * @return 操作之后的全部员工必填信息关联变量
     */
    @ApiOperation(value = "批量编辑、新增、删除员工必填信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "necessaryVariableBatchDTO", dataType = "NecessaryVariableBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(NecessaryVariableBatchDTO necessaryVariableBatchDTO);



    /**
     * 删除单个员工必填信息关联变量，彻底删除
     * @param necessaryVariableId 员工必填信息关联变量id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工必填信息关联变量，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "necessaryVariableId", dataType = "Long", value = "员工必填信息关联变量id", paramType = "path")
    })
    Result<Integer> delete(Long necessaryVariableId);


    /**
     * 批量删除员工必填信息关联变量，彻底删除
     * @param necessaryVariableIds 员工必填信息关联变量id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工必填信息关联变量，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "necessaryVariableIds", dataType = "Long[]", value = "员工必填信息关联变量id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] necessaryVariableIds);


    /**
     * 根据员工必填信息关联变量id查询员工必填信息关联变量详情
     * @param necessaryVariableId 员工必填信息关联变量id
     * @return 员工必填信息关联变量详情
     */
    @ApiOperation(value="根据员工必填信息关联变量id查询员工必填信息关联变量详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "necessaryVariableId", dataType = "Long", value = "员工必填信息关联变量id", paramType = "path")
    })
    Result<NecessaryVariableVO> findById(Long necessaryVariableId);


    /**
     * 查询员工必填信息关联变量
     * @param necessaryVariableQuery 员工必填信息关联变量查询参数
     * @return page
     */
    @ApiOperation(value="查询员工必填信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "necessaryVariableQuery", dataType = "NecessaryVariableQuery", value = "员工必填信息关联变量查询参数", paramType = "query")
    })
    Result<List<NecessaryVariableListVO>> listAll(NecessaryVariableQuery necessaryVariableQuery);


     /**
     * 分页查询员工必填信息关联变量
     * @param necessaryVariableQuery 员工必填信息关联变量查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工必填信息关联变量")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "necessaryVariableQuery", dataType = "NecessaryVariableQuery", value = "员工必填信息关联变量查询参数", paramType = "query")
    })
    Result<Page<NecessaryVariableListVO>> page(NecessaryVariableQuery necessaryVariableQuery);


}

